home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / door / path105.zip / INSTALL.BOI < prev    next >
Text File  |  1993-01-10  |  18KB  |  476 lines
  1. This document is effective 1/10/93
  2. INSTALL - BOI 2.01
  3.  
  4.  
  5.     BBS Onliner Interface
  6.     Copyright (C) 1990,1992 Andrew J. Mead
  7.     All Rights Reserved.
  8.  
  9. Introduction
  10.  
  11.     This document is a basic installation guide to doors written with
  12.     the BBS Onliner Interface.  A basic synopsis of the command line
  13.     arguments is given (please see COMMANDS.BOI), and examples (if
  14.     available) of installations under various BBS software are also
  15.     given.  You should also read any door specific documentation as
  16.     well since this only covers the options of the BOI.
  17.  
  18.       Sections
  19.  
  20.       Command Line Directives
  21.         Again Play                  /A
  22.         Player Name                 /N
  23.         Quiet Local Console         /Q
  24.         Limit Hall Of Fame          /X
  25.         Redirect Hall Of Fame       /Y
  26.         Maximum Time Limit          /Z
  27.         Communications Directives
  28.           Locked Com Port           /B
  29.  
  30.       Specific BBS Installation Examples and Notes
  31.         Generic Installation
  32.           Batch File Example
  33.         Generic Installation
  34.           Command Line Example
  35.         2 A.M.
  36.         Auntie
  37.         DoorWay to Unlimited Doors
  38.         EIS-PC
  39.         Force
  40.         FoReM
  41.         Forum
  42.         GAP
  43.         Genesis
  44.         GT Power
  45.         Maximus
  46.         ModuleX
  47.         OLEcom
  48.         Opus 1.13
  49.         Opus 1.14
  50.         PCBoard 12.x
  51.         PCBoard 14.x
  52.         Phoenix
  53.         ProBoard
  54.         QuickBBS
  55.         RBBS (batch /R)
  56.         Remote Access
  57.         RyBBS
  58.         Sapphire
  59.         Searchlight
  60.           Command Line Example (/9)
  61.         Simplex
  62.         Spitfire
  63.         TAG
  64.         Telegard
  65.         TPBoard
  66.         Virtual (batch /4, /S, or /Rn)
  67.         WildCat!
  68.         WWIV (batch /4)
  69.  
  70.       Other Notes
  71.         DESQview
  72.         Windows
  73.         OS/2 and other multitaskers
  74.         File Sharing/Locking
  75.  
  76.       What Went Wrong??? (or "Jane, how do I turn this thing off?")
  77.         Error messages
  78.  
  79. BBS Onliner Interface - Command Line Directives
  80.     Be sure to check out the door specific documentation about any
  81.     other command line directives that may be available.
  82.  
  83.     Again Play (/A:x)
  84.         This option will allow players to play multiple games at one
  85.         sitting as long as they have as muchtime.  If they have more
  86.         "x" minutes left (/a:x).  This option carries no recommendation.
  87.  
  88.     Player Name (/N:User_Name)
  89.         This switch is usually only necessary if the user information
  90.         is passed via command line instead of through a drop file (ie:
  91.         Searchlight BBS).  It can also be used for at home play with a
  92.         batch file to make things simple.
  93.  
  94.     Quiet Local Console (/Q)
  95.         This will keep the bell from beeping on the host computer.  This
  96.         lets the SysOp to spleep at night, and it is highly recommended.
  97.  
  98.     Limit Hall Of Fame (/X:n)
  99.         This options the player to a maximum of "n" appearences in the
  100.         Hall of Fame.  I recommend /x:2 as this keeps one or two rabid
  101.         players from monopolizing the Hall of Fame.
  102.  
  103.     Redirect Hall Of Fame (/Y:<path/filespec>
  104.         I heartily recommend using the text Hall of Fames as online
  105.         bulletins.  The BBSs around here that use the bulletins tend
  106.         to have 5 to 10 times the play as the BBSs that don't.  This
  107.         option is fully explained in COMMANDS.BOI.
  108.  
  109.     Maximum Time Limit (/Z:x)
  110.         The BOI normally limits users to the amount of time specified
  111.         in the drop file.  This option allows SysOps to set a maximum
  112.         upper limit.  The game will execute an inactivity time-out at
  113.         approximately two minutes.  It will beep at the halfway point
  114.         and then again when it returns control to the BBS.
  115.  
  116.     Communications Directives (/C /I /K /L F)
  117.         Communications directives are beyond the scope of this
  118.         document.  They are fully explained in COMMANDS.BOI.
  119.  
  120.         Locked Com Ports (/B)
  121.             The BOI (when not using FOSSIL), uses RTS (UART Ready To
  122.             Send) handshaking.  When you lock the DTE-DTC rate (your
  123.             computer to your modem) higher than the possible connect
  124.             rate between your modem and the remote (DTC-DTC rate), RTS
  125.             handshaking is insufficient, and may result in modem buffer
  126.             overruns and loss of data.  Adding this switch implements
  127.             RTS/CTS (Modem Clear To Send) handshaking.
  128.             This switch is strongly RECOMMENDED if you do not use F+.
  129.  
  130.  
  131. BBS Onliner Interface - Specific BBS Installation Examples and Notes
  132.  
  133.     This is where you can help.  I need samples.  Please send me your
  134.     setup.
  135.  
  136.     Generic Installation
  137.         Batch File Example
  138.             Until more examples arrive please check WWIV example.
  139.  
  140.         Command Line Example
  141.             Until more examples arrive please check Searchlight example.
  142.  
  143.     2 A.M. BBS
  144.         The /2 option reads JUMPER.DAT.  Installation example not
  145.         available.
  146.  
  147.     Auntie BBS
  148.         The /7 option reads a file called AUNTIE.SYS.  My information
  149.         on Auntie BBS is extremely limited, and you will also need to
  150.         supply the door with the communications information (/C or /I).
  151.         Installation example not available.
  152.  
  153.     DoorWay to Unlimited Doors
  154.         The /S options reads the "short" DOOR.SYS file.  Installation
  155.         example is not available.
  156.  
  157.     EIS-PC
  158.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  159.         available.
  160.  
  161.     Force
  162.         The /S options reads the "long" DOOR.SYS file.  This is a
  163.         proposed standard format for drop files.  Installation example
  164.         is not available.
  165.  
  166.     FoReM
  167.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  168.         available.
  169.  
  170.     Forum
  171.         The /F option reads USERINFO.TXT.  Installation example not
  172.         available.
  173.  
  174.     GAP
  175.         The /S options reads the "long" DOOR.SYS file.  This is a
  176.         proposed standard format for drop files.  Installation example
  177.         is not available.
  178.  
  179.     Genesis
  180.         The support for Genesis' CALLINFO.BBS is untested.  If you try
  181.         this /G option, please let me know whether or not it works.
  182.  
  183.     GT Power
  184.         The /0 option reads GT Power's GTUSER.BBS file.  There is one
  185.         crucial piece of information missing from the file, however.
  186.         GTUSER.BBS does not tell what commport the BBS is using.  If you
  187.         are running the BBS on COM1, you need not worry about anything,
  188.         but if you are not, you will need to use either the /C:x or the
  189.         /I:i:nnnn command.  I would like to thank Steven Wright for his
  190.         help in getting this option working.
  191.  
  192.     Maximus
  193.         The BOI is able to read many of the various drop files that
  194.         Maximus can create.  I would really appreciate it if I could
  195.         get hold of a few installation examples.
  196.  
  197.     ModuleX
  198.         The /M option reads NUMBER.TXT.  Installation example not
  199.         available.
  200.  
  201.     OLEcom
  202.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  203.         available.
  204.  
  205.     Opus-CBCS 1.13
  206.         My documentation on Opus 1.13's drop file(s) is incomplete.  I'd
  207.         appreciate any help.
  208.  
  209.     Opus-CBCS 1.14
  210.         The /Oxx option reads LASTUSxx.DAT (where xx is the Opus task
  211.         number in hexadecimal, if xx is not present the door looks for
  212.         a file called LASTUSER.DAT.).  Example:
  213.  
  214.         doorgame /o0e:c:\opus\
  215.  
  216.         the c:\opus\ tells it to look for LASTUS0E.DAT in the C:\OPUS\
  217.         directory.  Complete installation example is not available.
  218.  
  219.     PCBoard 12.x
  220.         The /1 option reads PCBOARD.SYS.  My documentation on this file
  221.         is incomplete, and I'd appreciate any additional information.
  222.         Installation example not available.
  223.  
  224.     PCBoard 14.x
  225.         The /P option reads PCBOARD.SYS.  As per PCBoard specifications
  226.         the BOI will blank out most of this file if the user drops
  227.         carrier while in the door.  Installation example not available.
  228.  
  229.     Phoenix
  230.         The /H option reads INFO.BBS.  Installation example not
  231.         available.
  232.  
  233.     ProBoard
  234.         I would really appreciate any information about dropfiles that
  235.         ProBoard creates.  Installation examples would also be nice.
  236.  
  237.     QuickBBS
  238.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  239.         available.
  240.  
  241.     RBBS
  242.         The /Rx option reads DORINFOx.DAT.  The follow installation
  243.         example is courtesy of Arnold Robinson.
  244.  
  245.         RBBS directory        -> C:\RBBS
  246.         batch file directory  -> C:\RBBS
  247.         batch file            -> DOORGAME.BAT
  248.         doorgame directory    -> C:\RBBS\DOOR
  249.            (DOORGAME.EXE, DOORGAME.INS, DOORGAME.LNG, DOORGAME.KEY)
  250.         bulletins directory   -> C:\RBBS\BULLETIN
  251.  
  252.         RBBS config parm 109  -> DOORS.DEF
  253.  
  254.         Put this line in C:\RBBS\DOORS.DEF
  255.         "DOORGAME",10,,D,"DOORGAME.BAT",N,,30
  256.  
  257.         what the values mean (most are optional), the values ar not
  258.         necessarily recommendation, merely what Arnold uses.
  259.             "DOORGAME"     - name of door
  260.             10             - securitly level
  261.             (blank)        - questionaire to execute
  262.             D              - "D"rop or "S"hell to door
  263.             "DOORGAME.BAT" - batch file to run
  264.             N              - ask for password on return (Y/N)
  265.             (blank)        - file to display on return
  266.             30             - max time allowed in door
  267.  
  268.         C:\RBBS\DOORGAME.BAT listing
  269.             @echo off
  270.             cd c:\rbbs\door
  271.             doorgame /r1c:\rbbs\ /yc:\rbbs\bulletin\ /q /x:2 /a /b
  272.             cd c:\rbbs
  273.  
  274.     Remote Access
  275.         Remote Access can run doors in several different ways (Type 7,
  276.         Type 15, command line).  The BOI should be able to handle all
  277.         of those using either DORINFOx.DAT or DOOR.SYS.  I would
  278.         appreciate any installation examples.  The /Rx option reads
  279.         DORINFOx.DAT.
  280.  
  281.     RyBBS
  282.         The /5 option reads CURRUSER.BBS.  Installation example not
  283.         available.
  284.  
  285.     Sapphire
  286.         My documentation on Sapphire's SAPPHIRE.DAT is incomplete. I
  287.         would appreciate any further information on what dropfiles that
  288.         Sapphire creates.
  289.  
  290.     Searchlight
  291.         I do not have any information regarding any drop files that
  292.         Searchlight creates.
  293.  
  294.         Command Line Example
  295.             The BOI allows BBSes to pass information to it via command
  296.             line.  This bypasses the need for batch files.  By using the
  297.             /9 switch, the BOI knows to get the information it needs
  298.             from the command line.  The /9 tells the BOI where to find
  299.             the door and its associated files.  For example
  300.  
  301.                 c:\slbbs\games\doorgame /9
  302.  
  303.             This command tells the BOI that all extra files (data files,
  304.             hall of fames, etc...) should be kept in c:\slbbs\games\.
  305.             You will also need to tell the BOI the user's name, the
  306.             amount of time the user has left, and the commport.  You
  307.             might try the following:
  308.  
  309.                 c:\slbbs\games\doorgame /9 /n%U /z%M /c:%P (...)
  310.  
  311.             The %U passes the door the users name (Andrew_Mead), the
  312.             %M passes the time remaining in minutes, and the %P tells
  313.             the door what commport is in use.  The elipses (...) just
  314.             represents the other switches you might choose to use.
  315.  
  316.     Simplex
  317.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  318.         available.
  319.  
  320.     Spitfire
  321.         The /6 option reads SFDOORS.DAT.  Installation example is not
  322.         available.
  323.  
  324.     TAG
  325.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  326.         available.
  327.  
  328.     Telegard
  329.         I believe that Telegard creates CHAIN.TXT, and installation is
  330.         probably similiar to that of WWIV.
  331.  
  332.     TPBoard
  333.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  334.         available.
  335.  
  336.     Virtual
  337.         Virtual BBS can create several different drop files.
  338.         Here is an example (courtesy Patrick Murray).  I recommend using
  339.         the /4 (CHAIN.TXT) command, as it shows both user name and
  340.         handle.  You can also use /Rn (DORINFOn.DEF) and /S (long
  341.         DOOR.SYS).
  342.  
  343.         CHAIN.TXT directory   -> C:\VBBS
  344.         batch file directory  -> C:\VBBS\GAMES
  345.         batch file            -> DOOR.BAT
  346.         doorgame directory    -> C:\VBBS\GAMES\DOOR
  347.            (DOORGAME.EXE, DOORGAME.INS, DOORGAME.LNG, DOORGAME.KEY)
  348.         bulletins directory   -> C:\VBBS\GAMES\HOF
  349.  
  350.         VConfig / Doors settings
  351.             1. Program Name: DoorGame (ANSI)
  352.             2. Command Line: C:\VBBS\GAMES\DOOR.BAT
  353.  
  354.         C:\WWIV\GAMES\DOOR.BAT listing
  355.             @echo off
  356.             cd c:\vbbs\games\door
  357.             doorgame /4c:\vbbs\ /yc:\vbbs\games\hof\ /q /x:2 /a /b
  358.             cd c:\vbbs
  359.  
  360.     WildCat!
  361.         The /W option reads CALLINFO.BBS.  Installation example is not
  362.         available.
  363.  
  364.     WWIV
  365.         The /4 option reads CHAIN.TXT.  This is the setting that I use
  366.         on my BBS (The Infinite Improbability BBS, @9952 WWIVnet). The
  367.         sample is for DOORGAME.EXE
  368.  
  369.         CHAIN.TXT directory   -> C:\WWIV
  370.         batch file directory  -> C:\WWIV\GAMES
  371.         batch file            -> door.bat
  372.         doorgame directory    -> C:\WWIV\GAMES\DOOR
  373.            (DOORGAME.EXE, DOORGAME.INS, DOORGAME.LNG, DOORGAME.KEY)
  374.         bulletins directory   -> C:\WWIV\GFILES\HOFSDIR
  375.  
  376.         //CHAINEDIT settings
  377.             A. Description  : DoorGame (ANSI)
  378.             B. Filename     : C:\WWIV\GAMES\DOOR.BAT
  379.             E. ANSI         : Required                <--- Optional
  380.             F. DOS Interrupt: NOT Used                <--- You need this
  381.             G. 300 Baud     : NOT Allowed             <--- Recommended
  382.             H. Shrink       : No                      <--- loads faster
  383.  
  384.         C:\WWIV\GAMES\DOOR.BAT listing
  385.             @echo off
  386.             cd c:\wwiv\games\door
  387.             doorgame /4c:\wwiv\ /yc:\wwiv\gfiles\hofsdir\ /q /x:2 /a /b
  388.             cd c:\wwiv
  389.  
  390. BBS Onliner Interface - Other Notes
  391.  
  392.     DESQview
  393.         The BBS Onliner Interface is DESQview aware.  It will give up
  394.         time to other applications while waiting for input.  If the
  395.         internal async routines are active, it will also alert DESQview
  396.         when it is in a critical state.
  397.  
  398.         Some notes are filtering in about QEMM complaining about the
  399.         command line.  One user stated he got the door working by
  400.         removing the extraneous colons from the command line.
  401.  
  402.                    /sc:\bbs\   instead of   /s:c:\bbs\
  403.  
  404.         I do not understand any of this, but it might help you out.  If
  405.         anyone can document any problems with QEMM or DESQview please
  406.         contact me.
  407.  
  408.     Windows, OS/2 and other DOS multitaskers
  409.         The BBS Onliner Interface will give up time slices to all DOS
  410.         based multitaskers that play by DOSes rules.  I have verified
  411.         reports that since this capability was added, Windows sessions
  412.         in other windows are now much, much faster.
  413.  
  414.     File Sharing/Locking
  415.         The BBS Onliner Interface now supports rudimentary file sharing
  416.         and locking.  If the author of the doors has used the built in
  417.         file handling routines, then the door should run well in multi-
  418.         node environments.
  419.  
  420.     What Went Wrong??? (or "Jane, how do I turn this thing off?")
  421.         Program Crashes at end of game.
  422.             You probably have a corrupted Hall of Fame data file.
  423.             Check the door specific documentation as to what files
  424.             might be involved.
  425.  
  426.         Error messages
  427.             Currently defined error messages that you will find in
  428.             BOIERR.LOG, their causes, and possible solutions.
  429.  
  430.             error  explained
  431.                2   Unkown or incorrect argument on command line.
  432.                3   Unsupported file format.  Please send me any and all
  433.                    information you might have on your BBS software's
  434.                    drop file, and I'll add support for it.
  435.                4   Unable to find file.
  436.                5   Error in file.  This means that file does not match
  437.                    the structure that I have for it.  If you are using
  438.                    a DOOR.SYS drop file, try using the other one (/S /D)
  439.                7   Duplicate directives.
  440.                8   Path/Filename for Hall of Fame is not valid.  You
  441.                    have given the /Y switch an invalid path/filespec.
  442.                9   Path not valid.
  443.               11   Invalid or missing number in /X:nn switch.
  444.               12   /X:nn value out of range.  This must be between 1-19.
  445.               13   Invalid or missing value in /C:n.  "n" must be a
  446.                    valid port number.  1 to 4 if you are not using a
  447.                    FOSSIL driver, and 1 to 8 if you are.
  448.               16   /L can not be used with either /C or /I.
  449.               17   Invald format in /I:i:nnnn.  The nnnn must use all
  450.                    four spaces.
  451.               18   Invald hexadecimal in /I:i:nnnn.
  452.               19   Invalid numeric in /A:x.
  453.               20   /A:x time value must be at least 5 minutes.
  454.               31   Unable to find/initialize FOSSIL driver.  Please
  455.                    notify me, and check your setup.  This switch should
  456.                    only occur if you use the F+ switch.
  457.  
  458.  
  459. BBS Onliner Interface
  460. Copyright (C) 1990, 1992 Andrew J. Mead
  461. All Rights Reserved.
  462.  
  463. Contact:
  464.     Andrew J. Mead
  465.     PO BOX 1155
  466.     Chapel Hill, NC 27514-1155
  467.     USA
  468.  
  469.     1@9952 WWIVnet
  470.     1@9395 VirtualNet
  471.     1:3641/417 FidoNet
  472.     75:7919/417 DoorNet
  473.  
  474.     +919 489 9446 - PCP:NCRTP - V32BIS - 24HRS
  475.  
  476. END INSTALL.BOI